inspur.ispim.edit_ipv4 module – Set ipv4 information
Note
This module is part of the inspur.ispim collection (version 2.2.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install inspur.ispim
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: inspur.ispim.edit_ipv4
.
New in inspur.ispim 1.0.0
Synopsis
Set ipv4 information on Inspur server.
Requirements
The below requirements are needed on the host that executes this module.
Python 3.7+
inspursmsdk
Parameters
Parameter |
Comments |
---|---|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Set interface_name. Choices:
|
|
If DHCP is disabled, specify a static IPv4 address to be configured for the selected interface. Required when ipv4_dhcp_enable=static. |
|
Enable ‘Enable DHCP’ to dynamically configure IPv4 address using Dynamic Host Configuration Protocol (DHCP). Choices:
|
|
If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface. Required when ipv4_dhcp_enable=static. |
|
Enable or disable IPV4. Choices:
|
|
If DHCP is disabled, specify a static Subnet Mask to be configured for the selected interface. Required when ipv4_dhcp_enable=static. |
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
A dict object containing connection details. |
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
Notes
Note
Does not support
check_mode
.
Examples
- name: Ipv4 test
hosts: ism
connection: local
gather_facts: no
vars:
ism:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Set ipv4 information"
inspur.ispim.edit_ipv4:
interface_name: "eth0"
ipv4_status: "disable"
provider: "{{ ism }}"
- name: "Set ipv4 information"
inspur.ispim.edit_ipv4:
interface_name: "eth0"
ipv4_status: "enable"
ipv4_dhcp_enable: "dhcp"
provider: "{{ ism }}"
- name: "Set ipv4 information"
inspur.ispim.edit_ipv4:
interface_name: "eth0"
ipv4_status: "enable"
ipv4_dhcp_enable: "static"
ipv4_address: "100.2.36.10"
ipv4_subnet: "255.255.255.0"
ipv4_gateway: "100.2.36.1"
provider: "{{ ism }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Check to see if a change was made on the device. Returned: always |
|
Messages returned after module execution. Returned: always |
|
Status after module execution. Returned: always |